appcompat/androidx.appcompat.widget/[main]ListPopupWindow

ListPopupWindow

open class ListPopupWindow : ShowableListMenu(source)

(SESL variant) Static library support version of the framework's android.widget.ListPopupWindow. Used to write apps that run on platforms prior to Android L. When running on Android L or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Inheritors

MenuPopupWindow

Constructors

ListPopupWindow

constructor(@NonNull context: @NonNull Context)

Create a new, empty popup window capable of displaying items from a ListAdapter.

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet)

Create a new, empty popup window capable of displaying items from a ListAdapter.

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, @AttrRes defStyleAttr: Int)

Create a new, empty popup window capable of displaying items from a ListAdapter.

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, @AttrRes defStyleAttr: Int, @StyleRes defStyleRes: Int)

Create a new, empty popup window capable of displaying items from a ListAdapter.

Properties

INPUT_METHOD_FROM_FOCUSABLE

val INPUT_METHOD_FROM_FOCUSABLE: Int = 0

Mode for setInputMethodMode: the requirements for the input method should be based on the focusability of the popup.

INPUT_METHOD_NEEDED

val INPUT_METHOD_NEEDED: Int = 1

Mode for setInputMethodMode: this popup always needs to work with an input method, regardless of whether it is focusable.

INPUT_METHOD_NOT_NEEDED

val INPUT_METHOD_NOT_NEEDED: Int = 2

Mode for setInputMethodMode: this popup never needs to work with an input method, regardless of whether it is focusable.

MATCH_PARENT

val MATCH_PARENT: Int = -1

Alias for MATCH_PARENT.

POSITION_PROMPT_ABOVE

val POSITION_PROMPT_ABOVE: Int = 0

The provided prompt view should appear above list content.

POSITION_PROMPT_BELOW

val POSITION_PROMPT_BELOW: Int = 1

The provided prompt view should appear below list content.

WRAP_CONTENT

val WRAP_CONTENT: Int = -2

Alias for WRAP_CONTENT.

Functions

clearListSelection

open fun clearListSelection()

Clear any current list selection.

createDragToOpenListener

open fun createDragToOpenListener(src: View): View.OnTouchListener

Returns an OnTouchListener that can be added to the source view to implement drag-to-open behavior.

dismiss

open fun dismiss()

Dismiss the popup window.

getAnchorView

@Nullable

open fun getAnchorView(): @Nullable View

Returns the view that will be used to anchor this popup.

getAnimationStyle

@StyleRes

open fun getAnimationStyle(): Int

Returns the animation style that will be used when the popup window is shown or dismissed.

getBackground

@Nullable

open fun getBackground(): @Nullable Drawable

getEpicenterBounds

@Nullable

open fun getEpicenterBounds(): @Nullable Rect

Return custom anchor-relative bounds of the popup's transition epicenter

getHeight

open fun getHeight(): Int

getHorizontalOffset

open fun getHorizontalOffset(): Int

getInputMethodMode

open fun getInputMethodMode(): Int

Return the current value in setInputMethodMode.

getListView

@Nullable

open fun getListView(): @Nullable ListView

getPromptPosition

open fun getPromptPosition(): Int

getSelectedItem

@Nullable

open fun getSelectedItem(): @Nullable Any

getSelectedItemId

open fun getSelectedItemId(): Long

getSelectedItemPosition

open fun getSelectedItemPosition(): Int

getSelectedView

@Nullable

open fun getSelectedView(): @Nullable View

getSoftInputMode

open fun getSoftInputMode(): Int

Returns the current value in setSoftInputMode.

getVerticalOffset

open fun getVerticalOffset(): Int

getWidth

open fun getWidth(): Int

isDropDownAlwaysVisible

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun isDropDownAlwaysVisible(): Boolean

isInputMethodNotNeeded

open fun isInputMethodNotNeeded(): Boolean

isModal

open fun isModal(): Boolean

Returns whether the popup window will be modal when shown.

isShowing

open fun isShowing(): Boolean

onKeyDown

open fun onKeyDown(keyCode: Int, @NonNull event: @NonNull KeyEvent): Boolean

Filter key down events.

onKeyPreIme

open fun onKeyPreIme(keyCode: Int, @NonNull event: @NonNull KeyEvent): Boolean

Filter pre-IME key events.

onKeyUp

open fun onKeyUp(keyCode: Int, @NonNull event: @NonNull KeyEvent): Boolean

Filter key up events.

performItemClick

open fun performItemClick(position: Int): Boolean

Perform an item click operation on the specified list adapter position.

postShow

open fun postShow()

Post a show call to the UI thread.

seslForceShowUpper

open fun seslForceShowUpper(force: Boolean)

seslSetAllowScrollingAnchorParent

open fun seslSetAllowScrollingAnchorParent(enabled: Boolean)

setAdapter

open fun setAdapter(@Nullable adapter: @Nullable ListAdapter)

Sets the adapter that provides the data and the views to represent the data in this popup window.

setAnchorView

open fun setAnchorView(@Nullable anchor: @Nullable View)

Sets the popup's anchor view.

setAnimationStyle

open fun setAnimationStyle(@StyleRes animationStyle: Int)

Set an animation style to use when the popup window is shown or dismissed.

setBackgroundDrawable

open fun setBackgroundDrawable(@Nullable d: @Nullable Drawable)

Sets a drawable to be the background for the popup window.

setContentWidth

open fun setContentWidth(width: Int)

Sets the width of the popup window by the size of its content.

setDropDownAlwaysVisible

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setDropDownAlwaysVisible(dropDownAlwaysVisible: Boolean)

Sets whether the drop-down should remain visible under certain conditions.

setDropDownGravity

open fun setDropDownGravity(gravity: Int)

Set the gravity of the dropdown list.

setEpicenterBounds

open fun setEpicenterBounds(@Nullable bounds: @Nullable Rect)

Specifies the custom anchor-relative bounds of the popup's transition epicenter.

setForceIgnoreOutsideTouch

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setForceIgnoreOutsideTouch(forceIgnoreOutsideTouch: Boolean)

Forces outside touches to be ignored.

setHeight

open fun setHeight(height: Int)

Sets the height of the popup window in pixels.

setHorizontalOffset

open fun setHorizontalOffset(offset: Int)

Set the horizontal offset of this popup from its anchor view in pixels.

setInputMethodMode

open fun setInputMethodMode(mode: Int)

Control how the popup operates with an input method: one of INPUT_METHOD_FROM_FOCUSABLE, INPUT_METHOD_NEEDED, or INPUT_METHOD_NOT_NEEDED.

setIsOverflowPopup

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setIsOverflowPopup(overflowPopup: Boolean)

setListSelector

open fun setListSelector(selector: Drawable)

Sets a drawable to use as the list item selector.

setModal

open fun setModal(modal: Boolean)

Set whether this window should be modal when shown.

setOnDismissListener

open fun setOnDismissListener(listener: @Nullable PopupWindow.OnDismissListener)

Set a listener to receive a callback when the popup is dismissed.

setOnItemClickListener

open fun setOnItemClickListener(clickListener: @Nullable AdapterView.OnItemClickListener)

Sets a listener to receive events when a list item is clicked.

setOnItemSelectedListener

open fun setOnItemSelectedListener(@Nullable selectedListener: @Nullable AdapterView.OnItemSelectedListener)

Sets a listener to receive events when a list item is selected.

setOverlapAnchor

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setOverlapAnchor(overlapAnchor: Boolean)

a submenu correctly.

setPromptPosition

open fun setPromptPosition(position: Int)

Set where the optional prompt view should appear.

setPromptView

open fun setPromptView(@Nullable prompt: @Nullable View)

Set a view to act as a user prompt for this popup window.

setSelection

open fun setSelection(position: Int)

Set the selected position of the list.

setSoftInputMode

open fun setSoftInputMode(mode: Int)

Sets the operating mode for the soft input area.

setVerticalOffset

open fun setVerticalOffset(offset: Int)

Set the vertical offset of this popup from its anchor view in pixels.

setWidth

open fun setWidth(width: Int)

Sets the width of the popup window in pixels.

setWindowLayoutType

open fun setWindowLayoutType(layoutType: Int)

Set the layout type for this popup window.

show

open fun show()

Show the popup list.

updatePopupHeightForFoldableModel

fun updatePopupHeightForFoldableModel(view: View): Int

ListPopupWindow

See also

Inheritors

Constructors

Properties

Functions